pipeline: outputs: datadog: added documentation for site configuration field #2032
Conversation
Signed-off-by: Lucas Tembras <[email protected]>
lucastemb
force-pushed
the
lucastemb/site_configuration_field
branch
from
64bf6ba to
ec88270
Compare
Signed-off-by: Lucas Tembras <[email protected]>
Signed-off-by: Lucas Tembras <[email protected]>
There was a problem hiding this comment.
thanks for submitting a PR @lucastemb 😁 I made one small suggestion to match the phrasing we've used in other pages, but otherwise LGTM!
one question, though: is the feature itself still unmerged? if so, you can add the waiting-on-code-merge label to this docs PR to make sure none of us merge it prematurely.
Co-authored-by: Alexa Kreizinger <[email protected]> Signed-off-by: Lucas Tembras <[email protected]>
|
@alexakreizinger Yup, still waiting for approval on the feature, but I don't believe I have the option to add the label myself. 😢 |
|
I executed CI workflows and added a suggested label. Thanks for your work! 👍 |
| @@ -28,8 +28,9 @@ This plugin uses the following configuration parameters: | |||
| | `dd_tags` | Optional. The [tags](https://docs.datadoghq.com/tagging/) you want to assign to your logs in Datadog. If unset, Datadog will look for the tags in the [`ddtags` attribute](https://docs.datadoghq.com/api/latest/logs/#send-logs). | _none_ | | |||
| | `dd_message_key` | By default, the plugin searches for the key `log` and remaps the value to the key `message`. If the property is set, the plugin will search the property name key. | _none_ | | |||
| | `dd_hostname` | The host the emitted logs should be associated with. If unset, Datadog expects the host to be set with `host`, `hostname`, or `syslog.hostname` attributes. See [Datadog Logs preprocessor documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines/?tab=host#preprocessing) for recognized attributes. | _none_ | | |||
| | workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` | | |||
| | header | Add additional arbitrary HTTP header key/value pair. Multiple headers can be set. | _none_ | | |||
| | `site` | Optional. The Datadog site to send logs to. Use `datadoghq.com` for US or `datadoghq.eu` for EU. If no value is specified, defaults to `datadoghq.com`. | `datadoghq.com` | | |||
There was a problem hiding this comment.
I think we should document how this interacts with the Host key. If both are set, which takes precedence?
We should mention in the description for the site and for the Host option.
There was a problem hiding this comment.
I'd also suggest moving this option up to the top of the list and moving Host to the bottom as we prefer people use site for simplicity.
Added supporting documentation for the following PR that seeks to add support for a
siteconfiguration field to give customers options on where to send telemetry data.